Skip to main content

Get Agent Profile List

GET : http://<base_url>/digipay/v3/agent_profile_threshold/agent_profile

This api is used to get agent profile list

QUERY PARAMS:-

ParameterTypeDescriptionValue
wallet_idStringunique wallet id associated with the agent profile64c1492cbb18436f8c754657042cc465
user_idIntunique user_id associated with the agent profile76bc712200ca444fa334f9e55e5fd7a8
tree_idStringa unique tree_id which is used to caculate commission for the user_type agent64c1492cbb18436f8c754657042cc465
tree_level_idStringfor the user_type agent a unique tree_level_id is used to calculate commission for agent64c1492cbb18436f8c754657042cc465
is_defaultBooleana boolean value where is_default can be either true/false"true/false
parent_agent_profile_idIntunique parent_agent_profile_id associated with the agent profile76bc712200ca444fa334f9e55e5fd7a8
is_activeBooleanif value is true it will show active languages in response, if value is false it will show inActive langauages in responsetrue/false
skipIntSkip the first n document from the query result1
limitIntLimits the number of records or documents that you want1
start_dateLongunix timestamp value in second1
end_dateLongunix timestamp value in second1
sortingStringSorting of the Data in the form of a string123
search_keywordstringa keyword which can be either name of language or a language code to get desired language as output123
currency_idStringunique currency_id assigned to the profile to perform transaction64c1492cbb18436f8c754657042cc465

HEADERS:-

ParameterTypedescriptionvalue
AuthorizationStringIt is a combination of type and token to authenticate user for the given tokenToken duik7309njdlkhdauhknksadhjkas986876sd873j
CompanyIDStringCompany_id is a unique primary id, that is represent company detail76bc712200ca444fa334f9e55e5fd7a8

Request Body:-

Request Example
curl --request GET \
--url 'http://192.168.1.102:8014/digipay/v3/agent_profile_threshold/agent_profile?wallet_id=76bc712200ca444fa334f9e55e5fd7a8&tree_id=76bc712200ca444fa334f9e55e5fd7a8&tree_level_id=76bc712200ca444fa334f9e55e5fd7a8&is_default=false&parent_agent_profile_id=76bc712200ca444fa334f9e55e5fd7a8&is_active=false&skip=1&limit=1&start_date=1&end_date=1&sorting=123&search_keyword=123' \
--header 'Authorization: Token duik7309njdlkhdauhknksadhjkas986876sd873j' \
--header 'CompanyID: 7753ad6bd8cf48f5b1312fd21eb36588' \
--header 'accept: application/json'

Response:-

Response 200(OK)

{
"success": 1,
"error": [],
"data": {
"agent_profile": [
{
"id": "52e10d1c2c6246c7a1c842a18bb0ff98",
"is_active": true,
"created_by": "7795cf982af741b1b4b2ebeb7bbdd8b8",
"updated_date": 1646377993,
"profile_name": "merchant full kyc"
"status_type": 1,
"is_default": false,
"tree_level_id": null,
"tree_id": null,
"wallet_id": "9bbbe9cc853d48e9a486574a04f4d5a7",
"user_id": "9bbbe9cc853d48e9a486574a04f4d5a7",
"parent_agent_profile_id": "9bbbe9cc853d48e9a486574a04f4d5a7"
}
]
}
}
Response 400(BAD REQUEST)
{
"success": 0,
"error"": [1],
"data": {
"message": "BAD_REQUEST",
}
}

RESPONSES :-

Status CodeDescription
200OK
400BAD REQUEST
404NOT FOUND
500INTERNAL SERVER ERROR